<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<HTML>
<HEAD>
<LINK REL=STYLESHEET TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<META NAME="GENERATOR" CONTENT="Java2HTML Version 1.3.1">
<TITLE>nl.justobjects.pushlet.core.Subscription (Java2HTML)</TITLE>
</HEAD>
<BODY><TABLE id="Header" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td colspan="2" width="33%">&nbsp;</td>
<td align="center" colspan="2" width="33%">
<font size="4">Subscription.java</font>
</td>
<td align="right" colspan="2" width="33%">&nbsp;</td>
</tr>
</TABLE>
<pre ID="Classes">
<FONT ID="LN">1 </FONT><A NAME="1"></A><FONT ID="SingleLineComment">// Copyright (c) 2000 Just Objects B.V. &lt;just@justobjects.nl&gt;
<FONT ID="LN">2 </FONT><A NAME="2"></A></FONT><FONT ID="SingleLineComment">// Distributable under LGPL license. See terms of license at gnu.org.
<FONT ID="LN">3 </FONT><A NAME="3"></A></FONT>
<FONT ID="LN">4 </FONT><A NAME="4"></A><FONT ID="Package">package</FONT> <A HREF="../../../../nl.justobjects.pushlet.core.index.html" target="packageFrame">nl.justobjects.pushlet.core</A>;
<FONT ID="LN">5 </FONT><A NAME="5"></A>
<FONT ID="LN">6 </FONT><A NAME="6"></A><FONT ID="Import">import</FONT> <A HREF="../../../../nl/justobjects/pushlet/util/Rand.java.html">nl.justobjects.pushlet.util.Rand</A>;
<FONT ID="LN">7 </FONT><A NAME="7"></A><FONT ID="Import">import</FONT> <A HREF="../../../../nl/justobjects/pushlet/util/PushletException.java.html">nl.justobjects.pushlet.util.PushletException</A>;
<FONT ID="LN">8 </FONT><A NAME="8"></A>
<FONT ID="LN">9 </FONT><A NAME="9"></A>
<FONT ID="LN">10</FONT><A NAME="10"></A><FONT ID="FormalComment">/**
<FONT ID="LN">11</FONT><A NAME="11"></A> * Represents single subject subscription
<FONT ID="LN">12</FONT><A NAME="12"></A> *
<FONT ID="LN">13</FONT><A NAME="13"></A> * @author Just van den Broecke - Just Objects &amp;copy;
<FONT ID="LN">14</FONT><A NAME="14"></A> * @version $Id: Subscription.java,v 1.5 2007/11/23 14:33:07 justb Exp $
<FONT ID="LN">15</FONT><A NAME="15"></A> */</FONT>
<FONT ID="LN">16</FONT><A NAME="16"></A><FONT ID="Public">public</FONT> <FONT ID="Class">class</FONT> Subscription <FONT ID="Implements">implements</FONT> <A HREF="../../../../nl/justobjects/pushlet/core/ConfigDefs.java.html">ConfigDefs</A> {
<FONT ID="LN">17</FONT><A NAME="17"></A>    <FONT ID="Public">public</FONT> <FONT ID="Static">static</FONT> <FONT ID="Final">final</FONT> <FONT ID="Int">int</FONT> ID_SIZE = <FONT ID="IntegerLiteral">5</FONT>;
<FONT ID="LN">18</FONT><A NAME="18"></A>    <FONT ID="Public">public</FONT> <FONT ID="Static">static</FONT> <FONT ID="Final">final</FONT> String SUBJECT_SEPARATOR = <FONT ID="StringLiteral">","</FONT>;
<FONT ID="LN">19</FONT><A NAME="19"></A>    <FONT ID="Private">private</FONT> String id = Rand.randomName(ID_SIZE);
<FONT ID="LN">20</FONT><A NAME="20"></A>    <FONT ID="Private">private</FONT> String subject;
<FONT ID="LN">21</FONT><A NAME="21"></A>    <FONT ID="Private">private</FONT> String[] subjects;
<FONT ID="LN">22</FONT><A NAME="22"></A>
<FONT ID="LN">23</FONT><A NAME="23"></A>    <FONT ID="FormalComment">/**
<FONT ID="LN">24</FONT><A NAME="24"></A>     * Optional label, a user supplied token.
<FONT ID="LN">25</FONT><A NAME="25"></A>     */</FONT>
<FONT ID="LN">26</FONT><A NAME="26"></A>    <FONT ID="Private">private</FONT> String label;
<FONT ID="LN">27</FONT><A NAME="27"></A>
<FONT ID="LN">28</FONT><A NAME="28"></A>
<FONT ID="LN">29</FONT><A NAME="29"></A>    <FONT ID="FormalComment">/**
<FONT ID="LN">30</FONT><A NAME="30"></A>     * Protected constructor as we create through factory method.
<FONT ID="LN">31</FONT><A NAME="31"></A>     */</FONT>
<FONT ID="LN">32</FONT><A NAME="32"></A>    <FONT ID="Protected">protected</FONT> Subscription() {
<FONT ID="LN">33</FONT><A NAME="33"></A>    }
<FONT ID="LN">34</FONT><A NAME="34"></A>
<FONT ID="LN">35</FONT><A NAME="35"></A>    <FONT ID="FormalComment">/**
<FONT ID="LN">36</FONT><A NAME="36"></A>     * Create instance through factory method.
<FONT ID="LN">37</FONT><A NAME="37"></A>     *
<FONT ID="LN">38</FONT><A NAME="38"></A>     * @param aSubject the subject (topic).
<FONT ID="LN">39</FONT><A NAME="39"></A>     * @return a Subscription object (or derived)
<FONT ID="LN">40</FONT><A NAME="40"></A>     * @throws nl.justobjects.pushlet.util.PushletException
<FONT ID="LN">41</FONT><A NAME="41"></A>     *          exception, usually misconfiguration
<FONT ID="LN">42</FONT><A NAME="42"></A>     */</FONT>
<FONT ID="LN">43</FONT><A NAME="43"></A>    <FONT ID="Public">public</FONT> <FONT ID="Static">static</FONT> <A HREF="../../../../nl/justobjects/pushlet/core/Subscription.java.html">Subscription</A> create(String aSubject) <FONT ID="Throws">throws</FONT> <A HREF="../../../../nl/justobjects/pushlet/util/PushletException.java.html">PushletException</A> {
<FONT ID="LN">44</FONT><A NAME="44"></A>        <FONT ID="Return">return</FONT> create(aSubject, <FONT ID="Null">null</FONT>);
<FONT ID="LN">45</FONT><A NAME="45"></A>    }
<FONT ID="LN">46</FONT><A NAME="46"></A>
<FONT ID="LN">47</FONT><A NAME="47"></A>    <FONT ID="FormalComment">/**
<FONT ID="LN">48</FONT><A NAME="48"></A>     * Create instance through factory method.
<FONT ID="LN">49</FONT><A NAME="49"></A>     *
<FONT ID="LN">50</FONT><A NAME="50"></A>     * @param aSubject the subject (topic).
<FONT ID="LN">51</FONT><A NAME="51"></A>     * @param aLabel   the subject label (optional).
<FONT ID="LN">52</FONT><A NAME="52"></A>     * @return a Subscription object (or derived)
<FONT ID="LN">53</FONT><A NAME="53"></A>     * @throws nl.justobjects.pushlet.util.PushletException
<FONT ID="LN">54</FONT><A NAME="54"></A>     *          exception, usually misconfiguration
<FONT ID="LN">55</FONT><A NAME="55"></A>     */</FONT>
<FONT ID="LN">56</FONT><A NAME="56"></A>    <FONT ID="Public">public</FONT> <FONT ID="Static">static</FONT> <A HREF="../../../../nl/justobjects/pushlet/core/Subscription.java.html">Subscription</A> create(String aSubject, String aLabel) <FONT ID="Throws">throws</FONT> <A HREF="../../../../nl/justobjects/pushlet/util/PushletException.java.html">PushletException</A> {
<FONT ID="LN">57</FONT><A NAME="57"></A>        <FONT ID="If">if</FONT> (aSubject == <FONT ID="Null">null</FONT> || aSubject.length() == <FONT ID="IntegerLiteral">0</FONT>) {
<FONT ID="LN">58</FONT><A NAME="58"></A>            <FONT ID="Throw">throw</FONT> <FONT ID="New">new</FONT> IllegalArgumentException(<FONT ID="StringLiteral">"Null or emtpy subject"</FONT>);
<FONT ID="LN">59</FONT><A NAME="59"></A>        }
<FONT ID="LN">60</FONT><A NAME="60"></A>
<FONT ID="LN">61</FONT><A NAME="61"></A>        <A HREF="../../../../nl/justobjects/pushlet/core/Subscription.java.html">Subscription</A> subscription;
<FONT ID="LN">62</FONT><A NAME="62"></A>        <FONT ID="Try">try</FONT> {
<FONT ID="LN">63</FONT><A NAME="63"></A>            subscription = (<A HREF="../../../../nl/justobjects/pushlet/core/Subscription.java.html">Subscription</A>) Config.getClass(SUBSCRIPTION_CLASS, <FONT ID="StringLiteral">"nl.justobjects.pushlet.core.Subscription"</FONT>).newInstance();
<FONT ID="LN">64</FONT><A NAME="64"></A>        } <FONT ID="Catch">catch</FONT> (Throwable t) {
<FONT ID="LN">65</FONT><A NAME="65"></A>            <FONT ID="Throw">throw</FONT> <FONT ID="New">new</FONT> <A HREF="../../../../nl/justobjects/pushlet/util/PushletException.java.html">PushletException</A>(<FONT ID="StringLiteral">"Cannot instantiate Subscriber from config"</FONT>, t);
<FONT ID="LN">66</FONT><A NAME="66"></A>        }
<FONT ID="LN">67</FONT><A NAME="67"></A>
<FONT ID="LN">68</FONT><A NAME="68"></A>        <FONT ID="SingleLineComment">// Init
<FONT ID="LN">69</FONT><A NAME="69"></A></FONT>        subscription.subject = aSubject;
<FONT ID="LN">70</FONT><A NAME="70"></A>
<FONT ID="LN">71</FONT><A NAME="71"></A>        <FONT ID="SingleLineComment">// We may subscribe to multiple subjects by separating
<FONT ID="LN">72</FONT><A NAME="72"></A></FONT>        <FONT ID="SingleLineComment">// them with SUBJECT_SEPARATOR, e.g. "/stocks/aex,/system/memory,..").
<FONT ID="LN">73</FONT><A NAME="73"></A></FONT>        subscription.subjects = aSubject.split(SUBJECT_SEPARATOR);
<FONT ID="LN">74</FONT><A NAME="74"></A>
<FONT ID="LN">75</FONT><A NAME="75"></A>        subscription.label = aLabel;
<FONT ID="LN">76</FONT><A NAME="76"></A>        <FONT ID="Return">return</FONT> subscription;
<FONT ID="LN">77</FONT><A NAME="77"></A>    }
<FONT ID="LN">78</FONT><A NAME="78"></A>
<FONT ID="LN">79</FONT><A NAME="79"></A>
<FONT ID="LN">80</FONT><A NAME="80"></A>    <FONT ID="Public">public</FONT> String getId() {
<FONT ID="LN">81</FONT><A NAME="81"></A>        <FONT ID="Return">return</FONT> id;
<FONT ID="LN">82</FONT><A NAME="82"></A>    }
<FONT ID="LN">83</FONT><A NAME="83"></A>
<FONT ID="LN">84</FONT><A NAME="84"></A>    <FONT ID="Public">public</FONT> String getLabel() {
<FONT ID="LN">85</FONT><A NAME="85"></A>        <FONT ID="Return">return</FONT> label;
<FONT ID="LN">86</FONT><A NAME="86"></A>    }
<FONT ID="LN">87</FONT><A NAME="87"></A>
<FONT ID="LN">88</FONT><A NAME="88"></A>    <FONT ID="Public">public</FONT> String getSubject() {
<FONT ID="LN">89</FONT><A NAME="89"></A>        <FONT ID="Return">return</FONT> subject;
<FONT ID="LN">90</FONT><A NAME="90"></A>    }
<FONT ID="LN">91</FONT><A NAME="91"></A>
<FONT ID="LN">92</FONT><A NAME="92"></A>    <FONT ID="FormalComment">/**
<FONT ID="LN">93</FONT><A NAME="93"></A>     * Determine if Event matches subscription.
<FONT ID="LN">94</FONT><A NAME="94"></A>     */</FONT>
<FONT ID="LN">95</FONT><A NAME="95"></A>    <FONT ID="Public">public</FONT> <FONT ID="Boolean">boolean</FONT> match(<A HREF="../../../../nl/justobjects/pushlet/core/Event.java.html">Event</A> event) {
<FONT ID="LN">96</FONT><A NAME="96"></A>        String eventSubject = event.getSubject();
<FONT ID="LN">97</FONT><A NAME="97"></A>
<FONT ID="LN">98</FONT><A NAME="98"></A>        <FONT ID="SingleLineComment">// Silly case but check anyway
<FONT ID="LN">99</FONT><A NAME="99"></A></FONT>        <FONT ID="If">if</FONT> (eventSubject == <FONT ID="Null">null</FONT> || eventSubject.length() == <FONT ID="IntegerLiteral">0</FONT>) {
<FONT ID="LN">00</FONT><A NAME="100"></A>            <FONT ID="Return">return</FONT> <FONT ID="False">false</FONT>;
<FONT ID="LN">01</FONT><A NAME="101"></A>        }
<FONT ID="LN">02</FONT><A NAME="102"></A>
<FONT ID="LN">03</FONT><A NAME="103"></A>        <FONT ID="SingleLineComment">// Test if one of the subjects matches
<FONT ID="LN">04</FONT><A NAME="104"></A></FONT>        <FONT ID="For">for</FONT> (<FONT ID="Int">int</FONT> i = <FONT ID="IntegerLiteral">0</FONT>; i &lt; subjects.length; i++) {
<FONT ID="LN">05</FONT><A NAME="105"></A>            <FONT ID="If">if</FONT> (eventSubject.startsWith(subjects[i])) {
<FONT ID="LN">06</FONT><A NAME="106"></A>                <FONT ID="Return">return</FONT> <FONT ID="True">true</FONT>;
<FONT ID="LN">07</FONT><A NAME="107"></A>            }
<FONT ID="LN">08</FONT><A NAME="108"></A>        }
<FONT ID="LN">09</FONT><A NAME="109"></A>
<FONT ID="LN">10</FONT><A NAME="110"></A>        <FONT ID="SingleLineComment">// No match
<FONT ID="LN">11</FONT><A NAME="111"></A></FONT>        <FONT ID="Return">return</FONT> <FONT ID="False">false</FONT>;
<FONT ID="LN">12</FONT><A NAME="112"></A>    }
<FONT ID="LN">13</FONT><A NAME="113"></A>}
<FONT ID="LN">14</FONT><A NAME="114"></A>
<FONT ID="LN">15</FONT><A NAME="115"></A><FONT ID="MultiLineComment">/*
<FONT ID="LN">16</FONT><A NAME="116"></A>  * $Log: Subscription.java,v $
<FONT ID="LN">17</FONT><A NAME="117"></A>  * Revision 1.5  2007/11/23 14:33:07  justb
<FONT ID="LN">18</FONT><A NAME="118"></A>  * core classes now configurable through factory
<FONT ID="LN">19</FONT><A NAME="119"></A>  *
<FONT ID="LN">20</FONT><A NAME="120"></A>  * Revision 1.4  2006/05/06 00:10:11  justb
<FONT ID="LN">21</FONT><A NAME="121"></A>  * various chgs but not too serious...
<FONT ID="LN">22</FONT><A NAME="122"></A>  *
<FONT ID="LN">23</FONT><A NAME="123"></A>  * Revision 1.3  2005/02/16 15:23:10  justb
<FONT ID="LN">24</FONT><A NAME="124"></A>  * multiple subject (, separated) support
<FONT ID="LN">25</FONT><A NAME="125"></A>  *
<FONT ID="LN">26</FONT><A NAME="126"></A>  * Revision 1.2  2005/01/18 16:47:10  justb
<FONT ID="LN">27</FONT><A NAME="127"></A>  * protocol changes for v2 and publishing from pushlet client
<FONT ID="LN">28</FONT><A NAME="128"></A>  *
<FONT ID="LN">29</FONT><A NAME="129"></A>  * Revision 1.1  2004/09/26 21:39:43  justb
<FONT ID="LN">30</FONT><A NAME="130"></A>  * allow multiple subscriptions and out-of-band requests
<FONT ID="LN">31</FONT><A NAME="131"></A>  *
<FONT ID="LN">32</FONT><A NAME="132"></A>  *
<FONT ID="LN">33</FONT><A NAME="133"></A>  */</FONT>
<FONT ID="LN">34</FONT><A NAME="134"></A></pre><TABLE id="Header" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td colspan="2" width="33%">&nbsp;</td>
<td align="center" colspan="2" width="33%">
<font size="4">Subscription.java</font>
</td>
<td align="right" colspan="2" width="33%">&nbsp;</td>
</tr>
</TABLE>

</BODY>
</HTML>